---
layout: m1x_soap
title: Memo List
---

<h3><a name="order_creditmemo.list-Module%3AOrderCreditMemoAPI"></a>Module: Order Credit Memo API</h3>

<h4><a name="order_creditmemo.list-Resource%3Asalesordercreditmemo"></a>Resource: sales_order_creditmemo</h4>

<h5><a name="order_creditmemo.list-Aliases%3Aordercreditmemo"></a>Aliases: order_creditmemo</h5>


<h5><a name="order_creditmemo.list-Method%3A"></a>Method:</h5>

<ul>
	<li>order_creditmemo.list (SOAP V1)</li>
	<li>salesOrderCreditmemoList (SOAP V2)</li>
</ul>


<p>Allows you to retrieve the list of credit memos by filters.</p>

<p><b>Arguments:</b></p>

<table><tbody>
<tr>
<th> Type </th>
<th> Name </th>
<th> Description </th>
</tr>
<tr>
<td> string </td>
<td> sessionId </td>
<td> Session ID </td>
</tr>
<tr>
<td> associative array </td>
<td> filters </td>
<td> Filters (optional) </td>
</tr>
</tbody></table>


<p><b>Return:</b></p>

<table><tbody>
<tr>
<th> Type </th>
<th> Name </th>
<th> Description </th>
</tr>
<tr>
<td> array </td>
<td> result </td>
<td> Array of salesOrderCreditmemoEntity </td>
</tr>
</tbody></table>


<p>The <b>salesOrderCreditmemoEntity</b> content is as follows:</p>

<table><tbody>
<tr>
<th> Type </th>
<th> Name </th>
<th> Description </th>
</tr>
<tr>
<td> string </td>
<td> updated_at </td>
<td> Date of updating </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> created_at <br class="atl-forced-newline" /> </td>
<td> Date of creation </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> increment_id <br class="atl-forced-newline" /> </td>
<td> Increment ID </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> transaction_id <br class="atl-forced-newline" /> </td>
<td> Transaction ID </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> global_currency_code <br class="atl-forced-newline" /> </td>
<td> Global currency code </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> base_currency_code <br class="atl-forced-newline" /> </td>
<td> Base currency code </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> order_currency_code <br class="atl-forced-newline" /> </td>
<td> Order currency code </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> store_currency_code <br class="atl-forced-newline" /> </td>
<td> Store currency code </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> cybersource_token <br class="atl-forced-newline" /> </td>
<td> Cybersource token </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> invoice_id <br class="atl-forced-newline" /> </td>
<td> ID of the invoice for which the credit memo was created </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> billing_address_id <br class="atl-forced-newline" /> </td>
<td> Billing address ID </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> shipping_address_id <br class="atl-forced-newline" /> </td>
<td> Shipping address ID </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> state <br class="atl-forced-newline" /> </td>
<td> State </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> creditmemo_status <br class="atl-forced-newline" /> </td>
<td> Credit memo status </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> email_sent <br class="atl-forced-newline" /> </td>
<td> Defines whether the email is sent </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> order_id <br class="atl-forced-newline" /> </td>
<td> ID of the order for which the credit memo was created </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> tax_amount <br class="atl-forced-newline" /> </td>
<td> Tax amount </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> shipping_tax_amount <br class="atl-forced-newline" /> </td>
<td> Shipping tax amount </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> base_tax_amount <br class="atl-forced-newline" /> </td>
<td> Base tax amount </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> base_adjustment_positive <br class="atl-forced-newline" /> </td>
<td> Adjustment refund amount (using base currency) <br class="atl-forced-newline" /> </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> base_grand_total <br class="atl-forced-newline" /> </td>
<td> Base grand total </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> adjustment <br class="atl-forced-newline" /> </td>
<td> Adjustment </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> subtotal <br class="atl-forced-newline" /> </td>
<td> Subtotal </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> discount_amount <br class="atl-forced-newline" /> </td>
<td> Discount amount </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> base_subtotal <br class="atl-forced-newline" /> </td>
<td> Base subtotal </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> base_adjustment <br class="atl-forced-newline" /> </td>
<td> Base adjustment </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> base_to_global_rate <br class="atl-forced-newline" /> </td>
<td> Base to global rate </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> store_to_base_rate <br class="atl-forced-newline" /> </td>
<td> Store to base rate </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> base_shipping_amount <br class="atl-forced-newline" /> </td>
<td> Base shipping amount </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> adjustment_negative <br class="atl-forced-newline" /> </td>
<td> Adjustment fee amount <br class="atl-forced-newline" /> </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> subtotal_incl_tax <br class="atl-forced-newline" /> </td>
<td> Subtotal including tax </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> shipping_amount <br class="atl-forced-newline" /> </td>
<td> Shipping amount </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> base_subtotal_incl_tax <br class="atl-forced-newline" /> </td>
<td> Base subtotal including tax </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> base_adjustment_negative <br class="atl-forced-newline" /> </td>
<td> Adjustment fee amount (using base currency) <br class="atl-forced-newline" /> </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> grand_total <br class="atl-forced-newline" /> </td>
<td> Grand total </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> base_discount_amount <br class="atl-forced-newline" /> </td>
<td> Base discount amount </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> base_to_order_rate <br class="atl-forced-newline" /> </td>
<td> Base to order rate </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> store_to_order_rate <br class="atl-forced-newline" /> </td>
<td> Store to order rate </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> base_shipping_tax_amount <br class="atl-forced-newline" /> </td>
<td> Base shipping tax amount </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> adjustment_positive <br class="atl-forced-newline" /> </td>
<td> Adjustment refund amount <br class="atl-forced-newline" /> </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> store_id <br class="atl-forced-newline" /> </td>
<td> Store ID </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> hidden_tax_amount <br class="atl-forced-newline" /> </td>
<td> Hidden tax amount </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> base_hidden_tax_amount <br class="atl-forced-newline" /> </td>
<td> Base hidden tax amount </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> shipping_hidden_tax_amount <br class="atl-forced-newline" /> </td>
<td> Shipping hidden tax amount </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> base_shipping_hidden_tax_amnt <br class="atl-forced-newline" /> </td>
<td> Base shipping hidden tax amount </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> shipping_incl_tax <br class="atl-forced-newline" /> </td>
<td> Shipping including tax </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> base_shipping_incl_tax <br class="atl-forced-newline" /> </td>
<td> Base shipping including tax </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> base_customer_balance_amount <br class="atl-forced-newline" /> </td>
<td> Base customer balance amount </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> customer_balance_amount <br class="atl-forced-newline" /> </td>
<td> Customer balance amount </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> bs_customer_bal_total_refunded <br class="atl-forced-newline" /> </td>
<td> Refunded base customer balance amount <br class="atl-forced-newline" /> </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> customer_bal_total_refunded <br class="atl-forced-newline" /> </td>
<td> Customer balance total refunded </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> base_gift_cards_amount <br class="atl-forced-newline" /> </td>
<td> Base gift cards amount </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> gift_cards_amount <br class="atl-forced-newline" /> </td>
<td> Gift cards amount </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> gw_base_price <br class="atl-forced-newline" /> </td>
<td> Gift wrapping price refunded amount (using base currency) <br class="atl-forced-newline" /> </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> gw_price <br class="atl-forced-newline" /> </td>
<td> Gift wrapping price refunded amount <br class="atl-forced-newline" /> </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> gw_items_base_price <br class="atl-forced-newline" /> </td>
<td> Gift wrapping items base price </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> gw_items_price <br class="atl-forced-newline" /> </td>
<td> Gift wrapping items&nbsp;price </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> gw_card_base_price <br class="atl-forced-newline" /> </td>
<td> Gift wrapping card base price </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> gw_card_price <br class="atl-forced-newline" /> </td>
<td> Gift wrapping card price </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> gw_base_tax_amount <br class="atl-forced-newline" /> </td>
<td> Gift wrapping tax amount refunded (using base currency) <br class="atl-forced-newline" /> </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> gw_tax_amount <br class="atl-forced-newline" /> </td>
<td> Gift wrapping tax amount refunded <br class="atl-forced-newline" /> </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> gw_items_base_tax_amount <br class="atl-forced-newline" /> </td>
<td> Gift wrapping items&nbsp;base tax amount </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> gw_items_tax_amount <br class="atl-forced-newline" /> </td>
<td> Gift wrapping items&nbsp;tax amount </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> gw_card_base_tax_amount <br class="atl-forced-newline" /> </td>
<td> Gift wrapping card base tax amount </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> gw_card_tax_amount <br class="atl-forced-newline" /> </td>
<td> Gift wrapping card tax amount </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> base_reward_currency_amount <br class="atl-forced-newline" /> </td>
<td> Base reward currency amount </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> reward_currency_amount <br class="atl-forced-newline" /> </td>
<td> Reward currency amount </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> reward_points_balance <br class="atl-forced-newline" /> </td>
<td> Reward points balance </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> reward_points_balance_refund <br class="atl-forced-newline" /> </td>
<td> Reward points balance refund </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> creditmemo_id <br class="atl-forced-newline" /> </td>
<td> Credit memo ID </td>
</tr>
<tr>
<td> array </td>
<td> items <br class="atl-forced-newline" /> </td>
<td> Array of salesOrderCreditmemoItemEntity </td>
</tr>
<tr>
<td> array </td>
<td> comments <br class="atl-forced-newline" /> </td>
<td> Array of salesOrderCreditmemoCommentEntity </td>
</tr>
</tbody></table>



<p>The <b>salesOrderCreditmemoItemEntity</b> content is as follows:</p>

<table><tbody>
<tr>
<th> Type </th>
<th> Name </th>
<th> Description </th>
</tr>
<tr>
<td> string </td>
<td> item_id </td>
<td> Credit memo item ID </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> parent_id <br class="atl-forced-newline" /> </td>
<td> Parent ID </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> weee_tax_applied_row_amount <br class="atl-forced-newline" /> </td>
<td> Applied fixed product tax row amount <br class="atl-forced-newline" /> </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> base_price <br class="atl-forced-newline" /> </td>
<td> Base price </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> base_weee_tax_row_disposition <br class="atl-forced-newline" /> </td>
<td> Fixed product tax row disposition (in base currency) <br class="atl-forced-newline" /> </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> tax_amount <br class="atl-forced-newline" /> </td>
<td> Tax amount </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> base_weee_tax_applied_amount <br class="atl-forced-newline" /> </td>
<td> Applied fixed product tax amount (in base currency) <br class="atl-forced-newline" /> </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> weee_tax_row_disposition <br class="atl-forced-newline" /> </td>
<td> Fixed product tax row disposition <br class="atl-forced-newline" /> </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> base_row_total <br class="atl-forced-newline" /> </td>
<td> Base row total </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> discount_amount <br class="atl-forced-newline" /> </td>
<td> Discount amount </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> row_total <br class="atl-forced-newline" /> </td>
<td> Row total </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> weee_tax_applied_amount <br class="atl-forced-newline" /> </td>
<td> Applied fixed product tax amount <br class="atl-forced-newline" /> </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> base_discount_amount <br class="atl-forced-newline" /> </td>
<td> Base discount amount </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> base_weee_tax_disposition <br class="atl-forced-newline" /> </td>
<td> Fixed product tax disposition (in base currency) <br class="atl-forced-newline" /> </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> price_incl_tax <br class="atl-forced-newline" /> </td>
<td> Price including tax </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> base_tax_amount <br class="atl-forced-newline" /> </td>
<td> Base tax amount </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> weee_tax_disposition <br class="atl-forced-newline" /> </td>
<td> Fixed product tax disposition <br class="atl-forced-newline" /> </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> base_price_incl_tax <br class="atl-forced-newline" /> </td>
<td> Base price including tax </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> qty <br class="atl-forced-newline" /> </td>
<td> Quantity </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> base_cost <br class="atl-forced-newline" /> </td>
<td> Base cost </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> base_weee_tax_applied_row_amount <br class="atl-forced-newline" /> </td>
<td> Applied fixed product tax row amount (in base currency) <br class="atl-forced-newline" /> </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> price <br class="atl-forced-newline" /> </td>
<td> Price </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> base_row_total_incl_tax <br class="atl-forced-newline" /> </td>
<td> Base row total including tax </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> row_total_incl_tax <br class="atl-forced-newline" /> </td>
<td> Row total including tax </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> product_id <br class="atl-forced-newline" /> </td>
<td> Product ID </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> order_item_id <br class="atl-forced-newline" /> </td>
<td> Order item ID </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> additional_data <br class="atl-forced-newline" /> </td>
<td> Additional data </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> description <br class="atl-forced-newline" /> </td>
<td> Description </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> weee_tax_applied <br class="atl-forced-newline" /> </td>
<td> Applied fixed product tax <br class="atl-forced-newline" /> </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> sku <br class="atl-forced-newline" /> </td>
<td> Item SKU </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> name <br class="atl-forced-newline" /> </td>
<td> Name </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> hidden_tax_amount <br class="atl-forced-newline" /> </td>
<td> Hidden tax amount </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> base_hidden_tax_amount <br class="atl-forced-newline" /> </td>
<td> Base hidden tax amount </td>
</tr>
</tbody></table>


<p>The <b>salesOrderCreditmemoCommentEntity</b> content is as follows:</p>

<table><tbody>
<tr>
<th> Type </th>
<th> Name </th>
<th> Description </th>
</tr>
<tr>
<td> string </td>
<td> parent_id <br class="atl-forced-newline" /> </td>
<td> Parent ID </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> created_at <br class="atl-forced-newline" /> </td>
<td> Date of creation </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> comment <br class="atl-forced-newline" /> </td>
<td> Comment data </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> is_customer_notified <br class="atl-forced-newline" /> </td>
<td> Defines whether the customer is notified </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> comment_id <br class="atl-forced-newline" /> </td>
<td> Comment ID </td>
</tr>
<tr>
<td> string <br class="atl-forced-newline" /> </td>
<td> is_visible_on_front <br class="atl-forced-newline" /> </td>
<td> Defines whether the comment is visible on the frontend </td>
</tr>
</tbody></table>


<p><b>Faults:</b></p>

<table><tbody>
<tr>
<th> Fault Code </th>
<th> Fault Description </th>
</tr>
<tr>
<td> 101 </td>
<td> Invalid filter given. Details in error message. </td>
</tr>
</tbody></table>


<h4><a name="order_creditmemo.list-Examples"></a>Examples</h4>

<h5><a name="order_creditmemo.list-RequestExampleSOAPV1"></a>Request Example SOAP V1</h5>

<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<div id="root">
		<pre class="theme: Default; brush: php; gutter: false">$proxy = new SoapClient('http://magentohost/api/soap/?wsdl');
$sessionId = $proxy-&gt;login('apiUser', 'apiKey');
$filter = array(
    'order_id' =&gt; array(
        'or' =&gt; array(
            array(
                'from' =&gt; '673',
                'to' =&gt; '674',
            ),
            array(
                'from' =&gt; '677',
                'to' =&gt; NULL,
            )
        )
    ),
    'increment_id' =&gt; array(
        'or' =&gt; array(
            array(
                'from' =&gt; '100000617',
                'to' =&gt; '100000619',
            ),
            array(
                'from' =&gt; '100000619',
                'to' =&gt; NULL,
            )
        )
    )
);
$creditmemoList = $proxy-&gt;call($sessionId, 'order_creditmemo.list', array($filter));</pre>
		</div>
</div></div>

<h5><a name="order_creditmemo.list-RequestExampleSOAPV2"></a>Request Example SOAP V2</h5>

<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<div id="root">
		<pre class="theme: Default; brush: php; gutter: false">$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); // TODO : change url
$sessionId = $proxy-&gt;login('apiUser', 'apiKey'); // TODO : change login and pwd if necessary

$result = $proxy-&gt;salesOrderCreditmemoList($sessionId, '200000001');
var_dump($result);</pre>
		</div>
</div></div>


<h5><a name="order_creditmemo.list-RequestExampleSOAPV2%28ComplexFilter%29"></a>Request Example SOAP V2 (Complex Filter)</h5>

<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<div id="root">
		<pre class="theme: Default; brush: php; gutter: false">$client = new SoapClient('http://magentohost/api/v2_soap/?wsdl');

// If some stuff requires api authentification,
// then get a session token
$session = $client-&gt;login('apiUser', 'apiKey');
$complexFilter = array(
    'complex_filter' =&gt; array(
        array(
            'key' =&gt; 'state',
            'value' =&gt; array('key' =&gt; 'in', 'value' =&gt; '2,3')
        )
    )
);
$result = $client-&gt;salesOrderCreditmemoList($session, $complexFilter);

var_dump ($result);</pre>
		</div>
</div></div>



<h5><a name="order_creditmemo.list-RequestExampleSOAPV2%28WSIComplianceMode%29"></a>Request Example SOAP V2 (WS-I Compliance Mode)</h5>

<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<div id="root">
		<pre class="theme: Default; brush: php; gutter: false">$proxy = new SoapClient('http://magentohost/api/v2_soap/?wsdl'); 

$sessionId = $proxy-&gt;login((object)array('username' =&gt; 'apiUser', 'apiKey' =&gt; 'apiKey')); 
 
$result = $proxy-&gt;salesOrderCreditmemoList((object)array('sessionId' =&gt; $sessionId-&gt;result));   
var_dump($result-&gt;result);</pre>
		</div>
</div></div>


<h5><a name="order_creditmemo.list-ResponseExampleSOAPV1"></a>Response Example SOAP V1</h5>

<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<div id="root">
		<pre class="theme: Default; brush: php; gutter: false">array(
    0 =&gt; array(
        'store_id' =&gt; '1',
        'adjustment_positive' =&gt; NULL,
        'base_shipping_tax_amount' =&gt; '0.0000',
        'store_to_order_rate' =&gt; '1.0000',
        'base_discount_amount' =&gt; '0.0000',
        'base_to_order_rate' =&gt; '1.0000',
        'grand_total' =&gt; '60.0000',
        'base_adjustment_negative' =&gt; NULL,
        'base_subtotal_incl_tax' =&gt; '55.0000',
        'shipping_amount' =&gt; '5.0000',
        'subtotal_incl_tax' =&gt; '55.0000',
        'adjustment_negative' =&gt; NULL,
        'base_shipping_amount' =&gt; '5.0000',
        'store_to_base_rate' =&gt; '1.0000',
        'base_to_global_rate' =&gt; '1.0000',
        'base_adjustment' =&gt; '0.0000',
        'base_subtotal' =&gt; '55.0000',
        'discount_amount' =&gt; '0.0000',
        'subtotal' =&gt; '55.0000',
        'adjustment' =&gt; '0.0000',
        'base_grand_total' =&gt; '60.0000',
        'base_adjustment_positive' =&gt; NULL,
        'base_tax_amount' =&gt; '0.0000',
        'shipping_tax_amount' =&gt; '0.0000',
        'tax_amount' =&gt; '0.0000',
        'order_id' =&gt; '674',
        'email_sent' =&gt; NULL,
        'creditmemo_status' =&gt; NULL,
        'state' =&gt; '2',
        'shipping_address_id' =&gt; '1348',
        'billing_address_id' =&gt; '1347',
        'invoice_id' =&gt; NULL,
        'cybersource_token' =&gt; NULL,
        'store_currency_code' =&gt; 'USD',
        'order_currency_code' =&gt; 'USD',
        'base_currency_code' =&gt; 'USD',
        'global_currency_code' =&gt; 'USD',
        'transaction_id' =&gt; NULL,
        'increment_id' =&gt; '100000617',
        'created_at' =&gt; '2011-05-26 10:49:45',
        'updated_at' =&gt; '2011-05-26 10:49:45',
        'hidden_tax_amount' =&gt; '0.0000',
        'base_hidden_tax_amount' =&gt; '0.0000',
        'shipping_hidden_tax_amount' =&gt; NULL,
        'base_shipping_hidden_tax_amnt' =&gt; NULL,
        'shipping_incl_tax' =&gt; '5.0000',
        'base_shipping_incl_tax' =&gt; '5.0000',
        'base_customer_balance_amount' =&gt; NULL,
        'customer_balance_amount' =&gt; NULL,
        'bs_customer_bal_total_refunded' =&gt; '0.0000',
        'customer_bal_total_refunded' =&gt; '0.0000',
        'base_gift_cards_amount' =&gt; NULL,
        'gift_cards_amount' =&gt; NULL,
        'gw_base_price' =&gt; NULL,
        'gw_price' =&gt; NULL,
        'gw_items_base_price' =&gt; NULL,
        'gw_items_price' =&gt; NULL,
        'gw_card_base_price' =&gt; NULL,
        'gw_card_price' =&gt; NULL,
        'gw_base_tax_amount' =&gt; NULL,
        'gw_tax_amount' =&gt; NULL,
        'gw_items_base_tax_amount' =&gt; NULL,
        'gw_items_tax_amount' =&gt; NULL,
        'gw_card_base_tax_amount' =&gt; NULL,
        'gw_card_tax_amount' =&gt; NULL,
        'base_reward_currency_amount' =&gt; NULL,
        'reward_currency_amount' =&gt; NULL,
        'reward_points_balance' =&gt; NULL,
        'reward_points_balance_refund' =&gt; NULL,
        'creditmemo_id' =&gt; '617',
    ),
    1 =&gt; array(
        'store_id' =&gt; '1',
        'adjustment_positive' =&gt; NULL,
        .......................................
        'creditmemo_id' =&gt; '620',
    )
);</pre>
		</div>
</div></div>

<?php include(__ROOT__ . 'footer.php'); ?>
